GET Forms?assetId={assetId}&formTypeId={formTypeId}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}&includeAttachmentContent={includeAttachmentContent}
Retrieves forms for the given parameters. All parameters are optional.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
assetId |
Id of the asset |
globally unique identifier |
None. |
formTypeId |
Id of the form type |
globally unique identifier |
None. |
take |
Number of forms to retrieve. Default is all forms |
integer |
None. |
skip |
Number of forms to skip before retrieval |
integer |
Default value is 0 |
sort |
List of sorting rules to describe how to sort the forms before retrieval |
Collection of Sort |
None. |
Operator | string |
None. |
|
Field | string |
None. |
|
Value | string |
None. |
|
Logic | string |
None. |
|
Filters | Collection of Filter |
None. |
|
includeAttachmentContent |
Include the file contents of the form field values if applicable |
boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
On success, a list of forms.
Name | Description | Type | Additional information |
---|---|---|---|
Data | Collection of Form |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": [ { "FormId": "9f74fb2e-bd2d-43c2-9e4e-1030ad9eb174", "Asset": { "AssetId": "43b3415e-3da2-4677-88e1-e9b47ac83715", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "08b9d5b8-8189-40e2-aa42-11d687b828f3", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "8a34e194-7046-4c8f-ac3a-b418097a1372", "CreateDate": "2024-05-01T22:01:31.0661408-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-01T22:01:31.0661408-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "8d255cb1-0f9d-4dd8-91b2-a7ed35c08e01", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-01T22:01:31.0661408-07:00", "MeasurementValueNeededDate": "2024-05-01T22:01:31.0661408-07:00", "SourceSystemId": "sample string 3", "CompanyId": "0442123c-66a7-477f-ab8d-1f069c3b78db", "CreateDate": "2024-05-01T22:01:31.0661408-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-01T22:01:31.0661408-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-05-01T22:01:31.0661408-07:00", "MeasurementValueNeededDate": "2024-05-01T22:01:31.0661408-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "81e19926-4c15-44fb-83f6-442d41af11c5", "CreateDate": "2024-05-01T22:01:31.0661408-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-01T22:01:31.0661408-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "0c9dcbb5-7e6a-448b-9967-41efdb60c6fa", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "08b9d5b8-8189-40e2-aa42-11d687b828f3", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "8a34e194-7046-4c8f-ac3a-b418097a1372", "CreateDate": "2024-05-01T22:01:31.0661408-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-01T22:01:31.0661408-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-05-01T22:01:31.0661408-07:00", "Fields": [ { "FormTypeFieldId": "900f9c33-1e72-438a-bbf6-d899c50fa7a8", "Section": { "FormTypeSectionId": "9be1d1ed-b081-4980-8e6a-9acffb1e7fdf", "Name": "sample string 1", "Label": "sample string 2", "DisplayOrder": 1, "IsRepeatable": true, "VisibleExpression": "sample string 4", "SourceSystemId": "sample string 5" }, "Name": "sample string 1", "Label": "sample string 2", "Description": "sample string 3", "DataType": { "DataTypeId": "84a4636c-351b-4c63-a7bc-d22295b09ade", "Name": "sample string 1" }, "Unit": { "UnitId": "85ff3198-219e-41ec-974b-b4e102bcf2a1", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "fa2de3b7-f698-4565-a8c5-f50ba59a82f7", "CreateDate": "2024-05-01T22:01:31.0661408-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-01T22:01:31.0661408-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "ValueExpression": "sample string 5", "RequiredExpression": "sample string 6", "IsAttachment": true, "DefaultValueExpression": "sample string 8", "IsAccumulator": true, "IsMultiline": true, "IsRepeatable": true, "VisibleExpression": "sample string 12", "SourceSystemId": "sample string 13" }, { "FormTypeFieldId": "900f9c33-1e72-438a-bbf6-d899c50fa7a8", "Section": { "FormTypeSectionId": "9be1d1ed-b081-4980-8e6a-9acffb1e7fdf", "Name": "sample string 1", "Label": "sample string 2", "DisplayOrder": 1, "IsRepeatable": true, "VisibleExpression": "sample string 4", "SourceSystemId": "sample string 5" }, "Name": "sample string 1", "Label": "sample string 2", "Description": "sample string 3", "DataType": { "DataTypeId": "84a4636c-351b-4c63-a7bc-d22295b09ade", "Name": "sample string 1" }, "Unit": { "UnitId": "85ff3198-219e-41ec-974b-b4e102bcf2a1", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "fa2de3b7-f698-4565-a8c5-f50ba59a82f7", "CreateDate": "2024-05-01T22:01:31.0661408-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-01T22:01:31.0661408-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "ValueExpression": "sample string 5", "RequiredExpression": "sample string 6", "IsAttachment": true, "DefaultValueExpression": "sample string 8", "IsAccumulator": true, "IsMultiline": true, "IsRepeatable": true, "VisibleExpression": "sample string 12", "SourceSystemId": "sample string 13" } ], "SourceSystemId": "sample string 3", "CompanyId": "5b27902e-db40-4d76-802e-47092dcd3ff4", "CreateDate": "2024-05-01T22:01:31.0661408-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-01T22:01:31.0661408-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2024-05-01T22:01:31.0661408-07:00", "Location": "sample string 1", "TaskId": "d659768b-bd4b-4af5-b9c3-146b83c0a024", "Values": [ { "FormFieldValueId": "1745ec69-9d62-424d-ac08-c3740400ce5f", "FormTypeField": { "FormTypeFieldId": "900f9c33-1e72-438a-bbf6-d899c50fa7a8", "Section": { "FormTypeSectionId": "9be1d1ed-b081-4980-8e6a-9acffb1e7fdf", "Name": "sample string 1", "Label": "sample string 2", "DisplayOrder": 1, "IsRepeatable": true, "VisibleExpression": "sample string 4", "SourceSystemId": "sample string 5" }, "Name": "sample string 1", "Label": "sample string 2", "Description": "sample string 3", "DataType": { "DataTypeId": "84a4636c-351b-4c63-a7bc-d22295b09ade", "Name": "sample string 1" }, "Unit": { "UnitId": "85ff3198-219e-41ec-974b-b4e102bcf2a1", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "fa2de3b7-f698-4565-a8c5-f50ba59a82f7", "CreateDate": "2024-05-01T22:01:31.0661408-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-01T22:01:31.0661408-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "ValueExpression": "sample string 5", "RequiredExpression": "sample string 6", "IsAttachment": true, "DefaultValueExpression": "sample string 8", "IsAccumulator": true, "IsMultiline": true, "IsRepeatable": true, "VisibleExpression": "sample string 12", "SourceSystemId": "sample string 13" }, "SectionIndex": 1, "FieldIndex": 1, "FileName": "sample string 1", "FileType": "sample string 2", "FileSize": 1, "FileContent": "QEA=", "ValueText": "sample string 3", "IsValid": true, "IsValidMessage": "sample string 5", "SourceSystemId": "sample string 6" }, { "FormFieldValueId": "1745ec69-9d62-424d-ac08-c3740400ce5f", "FormTypeField": { "FormTypeFieldId": "900f9c33-1e72-438a-bbf6-d899c50fa7a8", "Section": { "FormTypeSectionId": "9be1d1ed-b081-4980-8e6a-9acffb1e7fdf", "Name": "sample string 1", "Label": "sample string 2", "DisplayOrder": 1, "IsRepeatable": true, "VisibleExpression": "sample string 4", "SourceSystemId": "sample string 5" }, "Name": "sample string 1", "Label": "sample string 2", "Description": "sample string 3", "DataType": { "DataTypeId": "84a4636c-351b-4c63-a7bc-d22295b09ade", "Name": "sample string 1" }, "Unit": { "UnitId": "85ff3198-219e-41ec-974b-b4e102bcf2a1", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "fa2de3b7-f698-4565-a8c5-f50ba59a82f7", "CreateDate": "2024-05-01T22:01:31.0661408-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-01T22:01:31.0661408-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "ValueExpression": "sample string 5", "RequiredExpression": "sample string 6", "IsAttachment": true, "DefaultValueExpression": "sample string 8", "IsAccumulator": true, "IsMultiline": true, "IsRepeatable": true, "VisibleExpression": "sample string 12", "SourceSystemId": "sample string 13" }, "SectionIndex": 1, "FieldIndex": 1, "FileName": "sample string 1", "FileType": "sample string 2", "FileSize": 1, "FileContent": "QEA=", "ValueText": "sample string 3", "IsValid": true, "IsValidMessage": "sample string 5", "SourceSystemId": "sample string 6" } ], "SourceSystemId": "sample string 2", "CompanyId": "df14bd2b-1fec-4c68-b9a8-554a151a8044", "CreateDate": "2024-05-01T22:01:31.0661408-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-05-01T22:01:31.0661408-07:00", "LastModifiedUser": "sample string 5" }, { "FormId": "9f74fb2e-bd2d-43c2-9e4e-1030ad9eb174", "Asset": { "AssetId": "43b3415e-3da2-4677-88e1-e9b47ac83715", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "08b9d5b8-8189-40e2-aa42-11d687b828f3", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "8a34e194-7046-4c8f-ac3a-b418097a1372", "CreateDate": "2024-05-01T22:01:31.0661408-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-01T22:01:31.0661408-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "8d255cb1-0f9d-4dd8-91b2-a7ed35c08e01", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-01T22:01:31.0661408-07:00", "MeasurementValueNeededDate": "2024-05-01T22:01:31.0661408-07:00", "SourceSystemId": "sample string 3", "CompanyId": "0442123c-66a7-477f-ab8d-1f069c3b78db", "CreateDate": "2024-05-01T22:01:31.0661408-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-01T22:01:31.0661408-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-05-01T22:01:31.0661408-07:00", "MeasurementValueNeededDate": "2024-05-01T22:01:31.0661408-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "81e19926-4c15-44fb-83f6-442d41af11c5", "CreateDate": "2024-05-01T22:01:31.0661408-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-01T22:01:31.0661408-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "0c9dcbb5-7e6a-448b-9967-41efdb60c6fa", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "08b9d5b8-8189-40e2-aa42-11d687b828f3", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "8a34e194-7046-4c8f-ac3a-b418097a1372", "CreateDate": "2024-05-01T22:01:31.0661408-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-01T22:01:31.0661408-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-05-01T22:01:31.0661408-07:00", "Fields": [ { "FormTypeFieldId": "900f9c33-1e72-438a-bbf6-d899c50fa7a8", "Section": { "FormTypeSectionId": "9be1d1ed-b081-4980-8e6a-9acffb1e7fdf", "Name": "sample string 1", "Label": "sample string 2", "DisplayOrder": 1, "IsRepeatable": true, "VisibleExpression": "sample string 4", "SourceSystemId": "sample string 5" }, "Name": "sample string 1", "Label": "sample string 2", "Description": "sample string 3", "DataType": { "DataTypeId": "84a4636c-351b-4c63-a7bc-d22295b09ade", "Name": "sample string 1" }, "Unit": { "UnitId": "85ff3198-219e-41ec-974b-b4e102bcf2a1", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "fa2de3b7-f698-4565-a8c5-f50ba59a82f7", "CreateDate": "2024-05-01T22:01:31.0661408-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-01T22:01:31.0661408-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "ValueExpression": "sample string 5", "RequiredExpression": "sample string 6", "IsAttachment": true, "DefaultValueExpression": "sample string 8", "IsAccumulator": true, "IsMultiline": true, "IsRepeatable": true, "VisibleExpression": "sample string 12", "SourceSystemId": "sample string 13" }, { "FormTypeFieldId": "900f9c33-1e72-438a-bbf6-d899c50fa7a8", "Section": { "FormTypeSectionId": "9be1d1ed-b081-4980-8e6a-9acffb1e7fdf", "Name": "sample string 1", "Label": "sample string 2", "DisplayOrder": 1, "IsRepeatable": true, "VisibleExpression": "sample string 4", "SourceSystemId": "sample string 5" }, "Name": "sample string 1", "Label": "sample string 2", "Description": "sample string 3", "DataType": { "DataTypeId": "84a4636c-351b-4c63-a7bc-d22295b09ade", "Name": "sample string 1" }, "Unit": { "UnitId": "85ff3198-219e-41ec-974b-b4e102bcf2a1", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "fa2de3b7-f698-4565-a8c5-f50ba59a82f7", "CreateDate": "2024-05-01T22:01:31.0661408-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-01T22:01:31.0661408-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "ValueExpression": "sample string 5", "RequiredExpression": "sample string 6", "IsAttachment": true, "DefaultValueExpression": "sample string 8", "IsAccumulator": true, "IsMultiline": true, "IsRepeatable": true, "VisibleExpression": "sample string 12", "SourceSystemId": "sample string 13" } ], "SourceSystemId": "sample string 3", "CompanyId": "5b27902e-db40-4d76-802e-47092dcd3ff4", "CreateDate": "2024-05-01T22:01:31.0661408-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-01T22:01:31.0661408-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2024-05-01T22:01:31.0661408-07:00", "Location": "sample string 1", "TaskId": "d659768b-bd4b-4af5-b9c3-146b83c0a024", "Values": [ { "FormFieldValueId": "1745ec69-9d62-424d-ac08-c3740400ce5f", "FormTypeField": { "FormTypeFieldId": "900f9c33-1e72-438a-bbf6-d899c50fa7a8", "Section": { "FormTypeSectionId": "9be1d1ed-b081-4980-8e6a-9acffb1e7fdf", "Name": "sample string 1", "Label": "sample string 2", "DisplayOrder": 1, "IsRepeatable": true, "VisibleExpression": "sample string 4", "SourceSystemId": "sample string 5" }, "Name": "sample string 1", "Label": "sample string 2", "Description": "sample string 3", "DataType": { "DataTypeId": "84a4636c-351b-4c63-a7bc-d22295b09ade", "Name": "sample string 1" }, "Unit": { "UnitId": "85ff3198-219e-41ec-974b-b4e102bcf2a1", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "fa2de3b7-f698-4565-a8c5-f50ba59a82f7", "CreateDate": "2024-05-01T22:01:31.0661408-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-01T22:01:31.0661408-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "ValueExpression": "sample string 5", "RequiredExpression": "sample string 6", "IsAttachment": true, "DefaultValueExpression": "sample string 8", "IsAccumulator": true, "IsMultiline": true, "IsRepeatable": true, "VisibleExpression": "sample string 12", "SourceSystemId": "sample string 13" }, "SectionIndex": 1, "FieldIndex": 1, "FileName": "sample string 1", "FileType": "sample string 2", "FileSize": 1, "FileContent": "QEA=", "ValueText": "sample string 3", "IsValid": true, "IsValidMessage": "sample string 5", "SourceSystemId": "sample string 6" }, { "FormFieldValueId": "1745ec69-9d62-424d-ac08-c3740400ce5f", "FormTypeField": { "FormTypeFieldId": "900f9c33-1e72-438a-bbf6-d899c50fa7a8", "Section": { "FormTypeSectionId": "9be1d1ed-b081-4980-8e6a-9acffb1e7fdf", "Name": "sample string 1", "Label": "sample string 2", "DisplayOrder": 1, "IsRepeatable": true, "VisibleExpression": "sample string 4", "SourceSystemId": "sample string 5" }, "Name": "sample string 1", "Label": "sample string 2", "Description": "sample string 3", "DataType": { "DataTypeId": "84a4636c-351b-4c63-a7bc-d22295b09ade", "Name": "sample string 1" }, "Unit": { "UnitId": "85ff3198-219e-41ec-974b-b4e102bcf2a1", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "fa2de3b7-f698-4565-a8c5-f50ba59a82f7", "CreateDate": "2024-05-01T22:01:31.0661408-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-01T22:01:31.0661408-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "ValueExpression": "sample string 5", "RequiredExpression": "sample string 6", "IsAttachment": true, "DefaultValueExpression": "sample string 8", "IsAccumulator": true, "IsMultiline": true, "IsRepeatable": true, "VisibleExpression": "sample string 12", "SourceSystemId": "sample string 13" }, "SectionIndex": 1, "FieldIndex": 1, "FileName": "sample string 1", "FileType": "sample string 2", "FileSize": 1, "FileContent": "QEA=", "ValueText": "sample string 3", "IsValid": true, "IsValidMessage": "sample string 5", "SourceSystemId": "sample string 6" } ], "SourceSystemId": "sample string 2", "CompanyId": "df14bd2b-1fec-4c68-b9a8-554a151a8044", "CreateDate": "2024-05-01T22:01:31.0661408-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-05-01T22:01:31.0661408-07:00", "LastModifiedUser": "sample string 5" } ], "Total": 1, "Message": "sample string 1" }